﻿<?xml version="1.0" encoding="utf-8"?>
<topic id="" revisionNumber="0">
  <codeEntityDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
                      xmlns:xlink="http://www.w3.org/1999/xlink">
    <assembly>
      <assemblyName>An assembly name</assemblyName>
    </assembly>
    
    <codeEntities>
      <codeEntity>
        <codeEntityReference>Identifier such as M:MyNamespace.MyType.MyMethod(System.String)</codeEntityReference>
        
        <!-- NOTE: All of the following elements are optional -->
        
        <!-- An optional marker for internal use only -->
        <internalOnly/>
        <!-- An optional marker for inheriting documentation from its base type -->
        <useBase/>
        
        <clsCompliantAlternative>
          <codeEntityReference>An optional CLS-compliant alternative</codeEntityReference>
          <content>
            <para>This entity is not CLS compliant.</para>
          </content>
        </clsCompliantAlternative>
        
        <equivalentCodeEntity>
          <codeEntityReference>An optional equivalent, such as Equals for op_Equals</codeEntityReference>
          <content>
            <para>This entity has equivalents.</para>
          </content>
        </equivalentCodeEntity>
        
        <obsoleteCodeEntity>
          <codeEntityReference>An optional entity to be used instead of this entity</codeEntityReference>
          <content>
            <para>This entity has been deprecated.</para>
          </content>
        </obsoleteCodeEntity>

        <unmanagedCodeEntity>
          <codeEntityReference>An optional unmanaged entity relationship</codeEntityReference>
          <content>
            <para>This entity is related to an unmanaged API</para>
          </content>
        </unmanagedCodeEntity>

        <!-- NOTE: All of the following XML documentation elements are optional -->
        
        <summary>
          <para>An optional summary</para>
        </summary>
        
        <genericParameters>
          <genericParameter>
            <parameterReference>Generic parameter name</parameterReference>
            <content>
              <para>An optional generic parameter</para>
            </content>
          </genericParameter>
        </genericParameters>
        
        <parameters>
          <parameter>
            <parameterReference>Parameter name</parameterReference>
            <content>
              <para>An optional parameter</para>
            </content>
          </parameter>
        </parameters>
        
        <returnValue>
          <para>Optional return value information</para>
        </returnValue>

        <exceptions>
          <exception>
            <codeEntityReference>An optional exception entity reference</codeEntityReference>
            <content>
              <para>An exception thrown by this entity</para>
            </content>
          </exception>
        </exceptions>
        
        <threadSafety>
          <para>An optional message about thread safety</para>
        </threadSafety>
        
        <remarks>
          <content>
            <para>Optional remarks</para>
          </content>
        </remarks>

        <notesForImplementers>
          <para>An optional note for implementers</para>
        </notesForImplementers>
        
        <notesForCallers>
          <para>An optional note for callers</para>
        </notesForCallers>
        
        <notesForInheritors>
          <para>An optional note for inheritors</para>
        </notesForInheritors>
        
        <platformNotes>
          <platformNote>
            <platforms>
              <platform>Win98</platform>
              <platform>WinXpHome</platform>
              <!-- More platforms... -->
            </platforms>
            <content>
              <para>An optional note about platforms</para>
            </content>
          </platformNote>
        </platformNotes>
        
        <codeExamples>
          <codeExample>
            <code>An optional code example</code>
          </codeExample>
        </codeExamples>
        
        <permissions>
          <permission>
            <codeEntityReference>An optional permission entity reference</codeEntityReference>
            <content>
              <para>A permission required by this entity</para>
            </content>
          </permission>
        </permissions>

        <relatedTopics>
          <!-- Supported Link Types
    
               All of the following linking mechanisms may be used in the topic's content 
               as well as in the related topics section.
          
          Linking to API reference documentation: 
          
		          <codeEntityReference>API reference ID</codeEntityReference>

          Linking to external resources and custom HTML topics: 

              <externalLink>
                <linkText>  Required hyperlink text  </linkText>
                <linkAlternateText>  Optional link title  </linkAlternateText>
                <linkUri>  Required URI  </linkUri>
              </externalLink>
          
          Linking to other conceptual topics: 
          
              <link xlink:href="GUID topic name (without file extension)" />
                    
          Linking to named references:
          
              (Refer to the project's Help\Settings\links.xml file for more information)
          
              <link xref="id"> Optional link text </link>
              <link vref="id or URI"> Optional link text </link>
                
          -->

          <!-- Example Usage 

          <codeEntityReference>T:MyNamespace.MyClass</codeEntityReference>
          <codeEntityReference>P:MyNamespace.MyClass.MyProp</codeEntityReference>
          <codeEntityReference>M:System.IO.File.OpenText(System.String)</codeEntityReference>

          <externalLink>
            <linkText>Sandcastle Styles</linkText>
            <linkAlternateText>Sandcastle Styles on CodePlex</linkAlternateText>
            <linkUri>http://www.codeplex.com/SandcastleStyles</linkUri>
          </externalLink>

          <externalLink>
            <linkText>Change Log</linkText>
            <linkUri>ChangeLog.html</linkUri>
          </externalLink>

          <link xlink:href="2BFD9215-1216-403d-8C46-8420A4D01B83"/>
      
          <link xref="home">Our Home Page</link>
          <link vref="/controls/design.aspx">Control Architecture</link>
          -->
        </relatedTopics>
        
      </codeEntity>
    </codeEntities>
    
  </codeEntityDocument>
</topic>